feat: add generate fromTemplate command #221

Souvikns · 2022-02-09T06:34:59Z

Description
This PR aims to implement generate command that will replace Generator CLI

Related issue(s)

Resolves #9

Souvikns · 2022-02-09T14:21:21Z

@magicmatatjahu should I create local types for https://github.com/asyncapi/generator or is there a plan for adding typescript support?

magicmatatjahu · 2022-02-17T12:47:56Z

@Souvikns

should I create local types for https://github.com/asyncapi/generator or is there a plan for adding typescript support?

We have plan to add types asyncapi/generator#468 but as I see you added types in this project. For me it's not a problem, we can always remove them and switch to the official typing.

magicmatatjahu · 2022-02-21T14:19:21Z

src/commands/generate.ts

+        default: false,
+        description: 'force writing of the generated files to given directory even if it is a git repo with unstaged files or not empty dir (defaults to false)'
+      }),
+      'watch-tempalte': flags.boolean({


@Souvikns Some tip: you can use https://github.com/asyncapi/cli/blob/master/src/flags.ts#L3 that flag and that https://github.com/asyncapi/cli/blob/master/src/globals.ts#L28 helper to enable watcher :)

Souvikns · 2022-02-22T05:57:20Z

@magicmatatjahu I need your help with this

For some reason, due to generate command the CLI is throwing ts error all over the project.

Currently, I am getting these warnings when I run CLI.

Error Logs

PS D:\Programs\AsyncAPI\cli> ./bin/run 
(node:6664) TSError Plugin: @asyncapi/cli: ⨯ Unable to compile TypeScript:
src/commands/config/context.ts:2:5 - error TS7022: '__importDefault' implicitly has type 'any' because it does not have a type annotation and is referenced directly or indirectly in its own initializer.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
      ~~~~~~~~~~~~~~~
src/commands/config/context.ts:2:67 - error TS7006: Parameter 'mod' implicitly has an 'any' type.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
                                                                    ~~~

module: @oclif/[email protected]
task: toCached
plugin: @asyncapi/cli
root: D:\Programs\AsyncAPI\cli
See more details with DEBUG=*
(Use `node --trace-warnings ...` to show where the warning was created)
(node:6664) TSError Plugin: @asyncapi/cli: ⨯ Unable to compile TypeScript:
src/commands/start/studio.ts:2:67 - error TS7006: Parameter 'mod' implicitly has an 'any' type.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
                                                                    ~~~
src/commands/start/studio.ts:6:7 - error TS2451: Cannot redeclare block-scoped variable 'command_1'.

6 const command_1 = require("@oclif/command");
        ~~~~~~~~~

  src/commands/config/context.ts:6:7
    6 const command_1 = require("@oclif/command");
            ~~~~~~~~~
    'command_1' was also declared here.
src/commands/start/studio.ts:7:7 - error TS2451: Cannot redeclare block-scoped variable 'base_1'.

7 const base_1 = __importDefault(require("../../base"));
        ~~~~~~

  src/commands/config/context.ts:7:7
    7 const base_1 = __importDefault(require("../../base"));
            ~~~~~~
    'base_1' was also declared here.

module: @oclif/[email protected]
task: toCached
plugin: @asyncapi/cli
root: D:\Programs\AsyncAPI\cli
See more details with DEBUG=*
(node:6664) TSError Plugin: @asyncapi/cli: ⨯ Unable to compile TypeScript:
src/commands/config/context/add.ts:2:67 - error TS7006: Parameter 'mod' implicitly has an 'any' type.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
                                                                    ~~~
src/commands/config/context/add.ts:6:7 - error TS2451: Cannot redeclare block-scoped variable 'command_1'.

6 const command_1 = require("@oclif/command");
        ~~~~~~~~~

  src/commands/config/context.ts:6:7
    6 const command_1 = require("@oclif/command");
            ~~~~~~~~~
    'command_1' was also declared here.
src/commands/config/context/add.ts:7:7 - error TS2451: Cannot redeclare block-scoped variable 'base_1'.

7 const base_1 = __importDefault(require("../../../base"));
        ~~~~~~

  src/commands/config/context.ts:7:7
    7 const base_1 = __importDefault(require("../../base"));
            ~~~~~~
    'base_1' was also declared here.

module: @oclif/[email protected]
task: toCached
plugin: @asyncapi/cli
root: D:\Programs\AsyncAPI\cli
See more details with DEBUG=*
(node:6664) TSError Plugin: @asyncapi/cli: ⨯ Unable to compile TypeScript:
src/commands/config/context/current.ts:2:67 - error TS7006: Parameter 'mod' implicitly has an 'any' type.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
                                                                    ~~~
src/commands/config/context/current.ts:6:7 - error TS2451: Cannot redeclare block-scoped variable 'command_1'.

6 const command_1 = require("@oclif/command");
        ~~~~~~~~~

  src/commands/config/context.ts:6:7
    6 const command_1 = require("@oclif/command");
            ~~~~~~~~~
    'command_1' was also declared here.
src/commands/config/context/current.ts:7:7 - error TS2451: Cannot redeclare block-scoped variable 'base_1'.

7 const base_1 = __importDefault(require("../../../base"));
        ~~~~~~

  src/commands/config/context.ts:7:7
    7 const base_1 = __importDefault(require("../../base"));
            ~~~~~~
    'base_1' was also declared here.
src/commands/config/context/current.ts:8:7 - error TS2451: Cannot redeclare block-scoped variable 'Context_1'.

8 const Context_1 = require("../../../models/Context");
        ~~~~~~~~~

  src/commands/config/context/add.ts:8:7
    8 const Context_1 = require("../../../models/Context");
            ~~~~~~~~~
    'Context_1' was also declared here.

module: @oclif/[email protected]
task: toCached
plugin: @asyncapi/cli
root: D:\Programs\AsyncAPI\cli
See more details with DEBUG=*
(node:6664) TSError Plugin: @asyncapi/cli: ⨯ Unable to compile TypeScript:
src/commands/config/context/list.ts:2:67 - error TS7006: Parameter 'mod' implicitly has an 'any' type.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
                                                                    ~~~
src/commands/config/context/list.ts:6:7 - error TS2451: Cannot redeclare block-scoped variable 'command_1'.

6 const command_1 = require("@oclif/command");
        ~~~~~~~~~

  src/commands/config/context.ts:6:7
    6 const command_1 = require("@oclif/command");
            ~~~~~~~~~
    'command_1' was also declared here.
src/commands/config/context/list.ts:7:7 - error TS2451: Cannot redeclare block-scoped variable 'base_1'.

7 const base_1 = __importDefault(require("../../../base"));
        ~~~~~~

  src/commands/config/context.ts:7:7
    7 const base_1 = __importDefault(require("../../base"));
            ~~~~~~
    'base_1' was also declared here.
src/commands/config/context/list.ts:8:7 - error TS2451: Cannot redeclare block-scoped variable 'Context_1'.

8 const Context_1 = require("../../../models/Context");
        ~~~~~~~~~

  src/commands/config/context/add.ts:8:7
    8 const Context_1 = require("../../../models/Context");
            ~~~~~~~~~
    'Context_1' was also declared here.

module: @oclif/[email protected]
task: toCached
plugin: @asyncapi/cli
root: D:\Programs\AsyncAPI\cli
See more details with DEBUG=*
(node:6664) TSError Plugin: @asyncapi/cli: ⨯ Unable to compile TypeScript:
src/commands/config/context/remove.ts:2:67 - error TS7006: Parameter 'mod' implicitly has an 'any' type.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
                                                                    ~~~
src/commands/config/context/remove.ts:6:7 - error TS2451: Cannot redeclare block-scoped variable 'command_1'.

6 const command_1 = require("@oclif/command");
        ~~~~~~~~~

  src/commands/config/context.ts:6:7
    6 const command_1 = require("@oclif/command");
            ~~~~~~~~~
    'command_1' was also declared here.
src/commands/config/context/remove.ts:7:7 - error TS2451: Cannot redeclare block-scoped variable 'base_1'.

7 const base_1 = __importDefault(require("../../../base"));
        ~~~~~~

  src/commands/config/context.ts:7:7
    7 const base_1 = __importDefault(require("../../base"));
            ~~~~~~
    'base_1' was also declared here.
src/commands/config/context/remove.ts:8:7 - error TS2451: Cannot redeclare block-scoped variable 'Context_1'.

8 const Context_1 = require("../../../models/Context");
        ~~~~~~~~~

  src/commands/config/context/add.ts:8:7
    8 const Context_1 = require("../../../models/Context");
            ~~~~~~~~~
    'Context_1' was also declared here.

module: @oclif/[email protected]
task: toCached
plugin: @asyncapi/cli
root: D:\Programs\AsyncAPI\cli
See more details with DEBUG=*
(node:6664) TSError Plugin: @asyncapi/cli: ⨯ Unable to compile TypeScript:
src/commands/config/context/use.ts:2:67 - error TS7006: Parameter 'mod' implicitly has an 'any' type.

2 var __importDefault = (this && this.__importDefault) || function (mod) {
                                                                    ~~~
src/commands/config/context/use.ts:6:7 - error TS2451: Cannot redeclare block-scoped variable 'command_1'.

6 const command_1 = require("@oclif/command");
        ~~~~~~~~~

  src/commands/config/context.ts:6:7
    6 const command_1 = require("@oclif/command");
            ~~~~~~~~~
    'command_1' was also declared here.
src/commands/config/context/use.ts:7:7 - error TS2451: Cannot redeclare block-scoped variable 'base_1'.

7 const base_1 = __importDefault(require("../../../base"));
        ~~~~~~

  src/commands/config/context.ts:7:7
    7 const base_1 = __importDefault(require("../../base"));
            ~~~~~~
    'base_1' was also declared here.
src/commands/config/context/use.ts:8:7 - error TS2451: Cannot redeclare block-scoped variable 'Context_1'.

8 const Context_1 = require("../../../models/Context");
        ~~~~~~~~~

  src/commands/config/context/add.ts:8:7
    8 const Context_1 = require("../../../models/Context");
            ~~~~~~~~~
    'Context_1' was also declared here.

module: @oclif/[email protected]
task: toCached
plugin: @asyncapi/cli
root: D:\Programs\AsyncAPI\cli
See more details with DEBUG=*
All in one CLI for all AsyncAPI tools

VERSION
  @asyncapi/cli/0.14.1 win32-x64 node-v16.13.0

USAGE
  $ asyncapi [COMMAND]

COMMANDS
  config    access configs
  diff      find diff between two asyncapi files
  generate  Generator is a tool that you can use to generate whatever you want basing on the AsyncAPI specification file as an input.
  new       creates a new asyncapi file
  start     starts a new local instance of Studio
  validate  validate asyncapi file

PS D:\Programs\AsyncAPI\cli>

These warnings are coming from here

const generator = new Generator(template, flags.output || path.resolve(os.tmpdir(), 'asyncapi-generator'), {
  forceWrite: flags['force-write'],
  install: flags.install,
  debug: flags.debug,
  templateParams: params,
  noOverwriteGlobs: flags['no-overwrite'],
  mapBaseUrlToFolder: flags['map-base-url'],
  disableHooks,
  mapBaseURLToFolder
});
await generator.generateFomString(asyncapi.text());

To be precise it breaks in when I create a new Generator object. I am trying to follow this, but maybe I am missing something.

magicmatatjahu · 2022-02-28T13:52:39Z

@Souvikns I will check that but as I remember we had similar issue in the server-api project and I changed the imports to fix them. It's a problem with TS/TS-node, not with generator package.

Souvikns · 2022-03-02T02:20:33Z

https://github.com/asyncapi/generator/blob/1359f15a99a72f58380249b489bded4c29d0e978/package.json#L76-L77

@magicmatatjahu why does generator has ts-node and typescript as dependencies also why does it need typescript when it is a js project?

Found TypeStrong/ts-node#883 is this relevant in our case.

magicmatatjahu · 2022-03-02T09:09:22Z

@Souvikns For transpiling TS on the fly.

https://github.com/asyncapi/generator/blob/master/docs/authoring.md#typescript-support

Souvikns · 2022-03-08T10:55:24Z

@magicmatatjahu I tried ignoring the import but I am getting the same errors.

derberg · 2022-09-01T13:45:09Z

I found something about map-base-url flag, for some reason generateFromString command does not support map-base-url and which is something we are using because we are using CLI's load function for loading the spec file, so currently map-base-url flag does not work at all. What should we do, not use our CLI's load function?

Ah yes, cause we are not using generateFromURL as there is no point in doing it as we have our own load.
I think we should be consistent and use our own load function.

There are 2 options:

you just take https://github.com/asyncapi/generator/blob/master/lib/generator.js#L326-L328 and move it to generateFromString. I don't see a problem with it. In the end, somebody consciously passes mapBaseUrlToFolder to the constructor, so they know what they're doing 🤷🏼 and now the current solution limits/forces them to use generateFromURL 🤔
you can just make CLI responsible for getMapBaseUrlToFolderResolver, not rely on generator 🤔

I am struggling to solve this, generator does not have any errors that I can extend, one thing we can do is match output string and create our own errors and use them, or should we wait for asyncapi/community#266
@derberg what do your think?

yeah it will take some time until it is actually used in the generator. one thing we can do is match output string and create our own errors and use them is a good option, we just need to have some meaningful fallback, in case error strings change 😄

@magicmatatjahu @boyney123 any thoughts on above challenges?

package.json

README.md

Souvikns · 2022-09-09T08:52:08Z

you can just make CLI responsible for getMapBaseUrlToFolderResolver, not rely on generator 🤔

@derberg I went with this and also removed the stack from the output so now the error messages look something like this

The messages coming from the generator commands are self explanatory so I didn't changed anything, can you review and let me know if any thing needs to be changed.

src/commands/generate/fromTemplate.ts

derberg

@Souvikns 3 small suggestions,

in the meantime I'll do some manual testing

package.json

test/commands/generate/fromTemplate.test.ts

sonarqubecloud · 2022-09-26T11:52:22Z

Kudos, SonarCloud Quality Gate passed!

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication

derberg

@Souvikns amazing work done here 👏🏼 well well done 💪🏼

@magicmatatjahu as you were involved in this PR as well in regards to watcher, let us wait for your approval before merge too

magicmatatjahu

LGTM! 🚀

Souvikns · 2022-09-27T08:31:33Z

/rtm

asyncapi-bot · 2022-09-27T08:42:10Z

🎉 This PR is included in version 0.24.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

feat: implement generate command

f4789e0

Souvikns added 4 commits February 14, 2022 10:06

feat: add minimal generator functionalities

d282dae

feat: add parsing logic for flags

5978738

Merge remote-tracking branch 'upstream/master' into generator-command

633732d

fix: code smells

5e2b448

Souvikns marked this pull request as ready for review February 17, 2022 12:45

magicmatatjahu mentioned this pull request Feb 18, 2022

feat: add global specification watcher #220

Merged

magicmatatjahu reviewed Feb 21, 2022

View reviewed changes

Souvikns added 2 commits February 22, 2022 10:33

Merge branch 'master' into generator-command

69d20eb

chore: removing unused types

ee85ddf

chore: trying new ways to declare local type

664ca06

Souvikns added 2 commits February 28, 2022 19:41

chore: ignoring imports

8d3bf1e

Merge branch 'master' into generator-command

b45ea60

Souvikns mentioned this pull request Mar 3, 2022

v1.0.0 planning #251

Closed

16 tasks

Souvikns added 2 commits March 7, 2022 20:43

Merge remote-tracking branch 'upstream/master' into generator-command

cafbc72

chore: update generate command to use @oclif/core

0c9f54c

Souvikns requested review from derberg, boyney123 and asyncapi-bot-eve as code owners March 7, 2022 15:17

Souvikns added 4 commits March 15, 2022 12:05

Merge remote-tracking branch 'upstream/master' into generator-command

c5c93a6

Update package.json

8ddeb1a

chore: update test script

0b4e1a8

feat: add flag parsing logic for generator command

6243dc1

Souvikns added 4 commits September 7, 2022 13:49

Merge remote-tracking branch 'upstream/master' into generator-command

e6688fd

feat: remove stack logs from error messages

44c1cf6

chore: lint fix

f520fd4

feat: implement mapbaseurl and add test

6dd844d

M3lkior suggested changes Sep 8, 2022

View reviewed changes

package.json Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Souvikns added 2 commits September 9, 2022 14:16

refactor: readme update and help message update

845358c

Merge remote-tracking branch 'upstream/master' into generator-command

ea654c3

Souvikns added 6 commits September 15, 2022 14:07

Update README.md

1718392

Merge remote-tracking branch 'upstream/master' into generator-command

5c20518

Merge remote-tracking branch 'upstream/master' into generator-command

6e2f2c3

Merge remote-tracking branch 'upstream/master' into generator-command

26ec99f

Merge branch 'master' into generator-command

59f035e

feat: add remaining tests

51cef6e

Souvikns requested a review from derberg September 26, 2022 08:55

Souvikns commented Sep 26, 2022

View reviewed changes

src/commands/generate/fromTemplate.ts Show resolved Hide resolved

Souvikns commented Sep 26, 2022

View reviewed changes

src/commands/generate/fromTemplate.ts Show resolved Hide resolved

derberg reviewed Sep 26, 2022

View reviewed changes

package.json Show resolved Hide resolved

test/commands/generate/fromTemplate.test.ts Outdated Show resolved Hide resolved

test/commands/generate/fromTemplate.test.ts Outdated Show resolved Hide resolved

Update fromTemplate.test.ts

58a88b5

derberg changed the title ~~feat: implement generate command~~ feat: add generate fromTemplate command Sep 26, 2022

Update fromTemplate.test.ts

3fbf810

derberg approved these changes Sep 26, 2022

View reviewed changes

magicmatatjahu approved these changes Sep 27, 2022

View reviewed changes

asyncapi-bot added the ready-to-merge label Sep 27, 2022

asyncapi-bot merged commit 3bafd43 into asyncapi:master Sep 27, 2022

asyncapi-bot added the released label Sep 27, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add generate fromTemplate command #221

feat: add generate fromTemplate command #221

Souvikns commented Feb 9, 2022 •

edited by derberg

Loading

Souvikns commented Feb 9, 2022

magicmatatjahu commented Feb 17, 2022 •

edited

Loading

magicmatatjahu Feb 21, 2022

Souvikns commented Feb 22, 2022

magicmatatjahu commented Feb 28, 2022

Souvikns commented Mar 2, 2022

magicmatatjahu commented Mar 2, 2022

Souvikns commented Mar 8, 2022

derberg commented Sep 1, 2022

Souvikns commented Sep 9, 2022

derberg left a comment

sonarqubecloud bot commented Sep 26, 2022

derberg left a comment

magicmatatjahu left a comment

Souvikns commented Sep 27, 2022

asyncapi-bot commented Sep 27, 2022

feat: add generate fromTemplate command #221

feat: add generate fromTemplate command #221

Conversation

Souvikns commented Feb 9, 2022 • edited by derberg Loading

Souvikns commented Feb 9, 2022

magicmatatjahu commented Feb 17, 2022 • edited Loading

magicmatatjahu Feb 21, 2022

Choose a reason for hiding this comment

Souvikns commented Feb 22, 2022

magicmatatjahu commented Feb 28, 2022

Souvikns commented Mar 2, 2022

magicmatatjahu commented Mar 2, 2022

Souvikns commented Mar 8, 2022

derberg commented Sep 1, 2022

Souvikns commented Sep 9, 2022

derberg left a comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Sep 26, 2022

derberg left a comment

Choose a reason for hiding this comment

magicmatatjahu left a comment

Choose a reason for hiding this comment

Souvikns commented Sep 27, 2022

asyncapi-bot commented Sep 27, 2022

Souvikns commented Feb 9, 2022 •

edited by derberg

Loading

magicmatatjahu commented Feb 17, 2022 •

edited

Loading